/*
 *  Copyright 2009 David Kuhn <david.s.kuhn at gmail.com>.
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *  under the License.
 */
package com.google.code.teamtools.domain;

import java.util.Date;

/**
 * Interface for a resource request.
 * 
 * @author David Kuhn
 */
public interface IResourceRequest extends IEntity
{
    /**
     * Returns the number of days effort for the period requested.
     * 
     * @return
     */
    float getEffortInDays();
    
    /**
     * Returns the end date of the period the request is for.
     * 
     * @return the request end date
     */
    Date getEndDate();
    
    /**
     * Returns the project the request belongs to.
     * 
     * @return the project
     */
    IProject getProject();
    
    /**
     * Returns the role requested by the project.
     * 
     * @return the role requested
     */
    IRole getRole();
   
    /**
     * Returns the skill requested by the project.
     * 
     * @return the skill requested
     */
    ISkill getSkill();
    
    /**
     * Returns the start date of the period that the request is for.
     * 
     * @return
     */
    Date getStartDate();
    
    /**
     * Sets the effort required in days. This may be a fractional amount.
     * 
     * @param days the number of days to set
     */
    void setEffortInDays(float days);
    
    /**
     * Sets the end date for the request period.
     * 
     * @param endDate the end date to set
     */
    void setEndDate(Date endDate);
    
    /**
     * Sets the project which this request belongs to.
     * 
     * @param project the project to set
     */
    void setProject(IProject project);
    
    /**
     * Sets the role that the project has requested.
     * 
     * @param role the role to set
     */
    void setRole(IRole role);
    
    /**
     * Sets the skill that the project has requested.
     * 
     * @param skill the skill to set
     */
    void setSkill(ISkill skill);
    
    /**
     * Sets the start date for the request period.
     * 
     * @param startDate the start date to set
     */
    void setStartDate(Date startDate);
}
